Serde YML: Seamless YAML Serialization for Rust
Serde YML
is a Rust library that simplifies YAML serialization and deserialization using the popular Serde framework. It provides a convenient and efficient way to convert Rust data structures to YAML format and vice versa.
Credits and Acknowledgements
This new library draws inspiration from the excellent work done by David Tolnay and the maintainers of the serde-yaml library. While Serde YML started as a fork of serde-yaml, it has now evolved into a separate library with its own goals and direction in mind.
If you are currently using serde-yaml in your projects, we recommend carefully evaluating your requirements and considering the stability and maturity of the original library before migrating to Serde YML.
Finally, I would like to express my sincere gratitude to David Tolnay and the serde-yaml team for their valuable contributions to the Rust community and for inspiring this project.
• Website • Documentation • Report Bug • Request Feature • Contributing Guidelines
Features
- Serialization and deserialization of Rust data structures to/from YAML format
- Support for custom structs and enums using Serde's derive macros
- Handling of YAML's
!tag
syntax for representing enum variants - Direct access to YAML values through the
Value
type and related types likeMapping
andSequence
- Comprehensive error handling with
Error
,Location
, andResult
types - Serialization to YAML using
to_string
andto_writer
functions - Deserialization from YAML using
from_str
,from_slice
, andfrom_reader
functions - Customizable serialization and deserialization behavior using Serde's
#[serde(with = ...)]
attribute - Support for serializing/deserializing enums using a YAML map with a single key-value pair through the
singleton_map
module - Recursive application of
singleton_map
serialization/deserialization to all enums within a data structure using thesingleton_map_recursive
module - Serialization and deserialization of optional enum fields using the
singleton_map_optional
module - Handling of nested enum structures with optional inner enums using the
singleton_map_recursive
module - Customization of serialization and deserialization logic for enums using the
singleton_map_with
module and custom helper functions
Rust Version Compatibility
This library is compatible with Rust 1.60 and above.
Installation
Add the following dependency to your Cargo.toml
file:
[]
= "0.0.5"
Usage
Serde YML offers a straightforward and intuitive API for working with YAML data in Rust. Here's a quick example of how to serialize and deserialize a Rust type:
use ;
Examples
Serde YML provides a set of comprehensive examples to demonstrate its usage and capabilities. You can find them in the examples
directory of the project.
To run the examples, clone the repository and execute the following command in your terminal from the project root directory:
cargo run --example example
The examples cover various scenarios, including serializing and deserializing structs, enums, optional fields, custom structs, and more.
Here are a few notable examples:
Serializing and Deserializing Structs
use ;
use serde_yml;
This example demonstrates how to serialize and deserialize a simple struct Point
to and from YAML using the serde_yml
crate.
Serializing and Deserializing Enums
use ;
use serde_yml;
This example demonstrates how to serialize and deserialize an enum Shape
(with struct variants) to and from YAML using the serde_yml
crate.
Serializing and Deserializing Optional Fields
use ;
use serde_yml;
This example demonstrates how to serialize and deserialize a struct User
with an optional field age
to and from YAML using the serde_yml
crate.
Serializing and Deserializing a HashMap
use HashMap;
This example demonstrates how to serialize and deserialize a HashMap
to and from YAML using the serde_yml
crate.
Serializing and Deserializing Custom Structs
use ;
This example demonstrates how to serialize and deserialize a custom struct Person
to and from YAML using the serde_yml
crate.
Using Serde derive
It can also be used with Serde's derive macros to handle structs and enums defined in your program.
Structs serialize in the obvious way:
# use ;
Enums serialize using YAML's !tag
syntax to identify the variant name.
use ;
This example demonstrates how to use Serde's derive macros to automatically implement the Serialize
and Deserialize
traits for a struct Point
, and then serialize and deserialize it to and from YAML using the serde_yml
crate.
Serializing and Deserializing Enums with Custom Serialization and Deserialization
use ;
use ;
use ;
use fmt;
// Custom Serialize and Deserialize implementations for MyStruct
// ...
This example demonstrates how to use custom Serialize
and Deserialize
implementations for a struct containing an enum field, and how to leverage serde_yml
to serialize and deserialize the struct to and from YAML.
Serializing and Deserializing Optional Enums
use ;
use singleton_map_optional;
// ...
This example demonstrates how to use the singleton_map_optional
attribute to serialize and deserialize an Option<Enum>
field as a single YAML mapping entry with the key being the enum variant name.
Serializing and Deserializing Nested Enums
use ;
use singleton_map_recursive;
// ...
This example demonstrates how to use the singleton_map_recursive
attribute to serialize and deserialize a nested enum structure where one of the enum variants contains an optional inner enum.
Serializing and Deserializing Enums with singleton_map_recursive
use ;
use singleton_map_recursive;
// ...
This example demonstrates how to use the singleton_map_recursive
attribute to serialize and deserialize an enum field as a single YAML mapping entry with the key being the enum variant name.
Serializing and Deserializing Enums with singleton_map_with
and Custom Serialization
use ;
use singleton_map_with;
This example demonstrates how to use the singleton_map_with
attribute in combination with a custom serialization function (custom_serialize
) to serialize and deserialize an enum field (MyEnum
) within a struct (MyStruct
).
The custom_serialize
function is used for serialization, while the singleton_map_with::deserialize
function is used for deserialization. This allows for additional customization of the serialization process while still leveraging the singleton_map_with attribute for deserialization.
Serializing and Deserializing Enums with singleton_map_with
use ;
use singleton_map_with;
This example demonstrates how to use the singleton_map_with
attribute to serialize and deserialize an enum field (MyEnum
) within a struct (MyStruct
). The singleton_map_with
attribute allows for additional customization of the serialization and deserialization process through the use of helper functions.
Best Practices and Common Pitfalls
- When serializing large datasets, consider using
serde_yml::to_writer
to write the YAML output directly to a file or a writer instead of keeping the entire serialized string in memory. - Be cautious when deserializing untrusted YAML input, as it may contain unexpected or malicious data. Always validate and handle the deserialized data appropriately.
- When working with custom structs or enums, ensure that they implement the necessary Serde traits (
Serialize
andDeserialize
) for proper serialization and deserialization. - If you encounter any issues or have questions, refer to the library's documentation and examples for guidance. If the problem persists, consider opening an issue on the library's GitHub repository.
Installation
To use Serde YML in your Rust project, add the following to your Cargo.toml
file:
[dependencies]
serde_yml = "0.0.5"
Semantic Versioning Policy
For transparency into our release cycle and in striving to maintain
backward compatibility, serde_yml
follows semantic versioning.
License
The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).
Contribution
We welcome all people who want to contribute. Please see the contributing instructions for more information.
Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Acknowledgements
A big thank you to all the awesome contributors of serde_yml for their help and support. A special thank you goes to David Tolnay and his work on Serde YAML for inspiring this project.